GET StateTypes?assetTypeId={assetTypeId}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves state types for the given parameters. All parameters are optional.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
assetTypeId |
Id of the asset type |
globally unique identifier |
None. |
take |
Number of state types to retrieve. Default is all state types |
integer |
None. |
skip |
Number of state types to skip before retrieval |
integer |
Default value is 0 |
sort |
List of sorting rules to describe how to sort the state types before retrieval |
Collection of Sort |
None. |
Operator | string |
None. |
|
Field | string |
None. |
|
Value | string |
None. |
|
Logic | string |
None. |
|
Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of state types.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Collection of StateType |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": [ { "StateTypeId": "3216b1e6-54d9-4bd9-8892-e5e2e59141c4", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "a60b163f-97bd-4d26-929f-ec5731a8f715", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "8861d7ad-a5b2-4c71-8afb-8796f5660581", "CreateDate": "2024-05-06T11:28:20.4243889-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T11:28:20.4243889-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "4e25f356-ddf5-49a7-88b0-86e3a0fe87ca", "CreateDate": "2024-05-06T11:28:20.4243889-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-06T11:28:20.4243889-07:00", "LastModifiedUser": "sample string 6" }, { "StateTypeId": "3216b1e6-54d9-4bd9-8892-e5e2e59141c4", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "a60b163f-97bd-4d26-929f-ec5731a8f715", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "8861d7ad-a5b2-4c71-8afb-8796f5660581", "CreateDate": "2024-05-06T11:28:20.4243889-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T11:28:20.4243889-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "4e25f356-ddf5-49a7-88b0-86e3a0fe87ca", "CreateDate": "2024-05-06T11:28:20.4243889-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-06T11:28:20.4243889-07:00", "LastModifiedUser": "sample string 6" } ], "Total": 1, "Message": "sample string 1" }